// Copyright (c) 2010, Anthony Cassidy
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without modification, are 
// permitted provided that the following conditions are met:
// 
//     * Redistributions of source code must retain the above copyright notice, this list 
//         of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright notice, this 
//         list of conditions and the following disclaimer in the documentation and/or 
//         other materials provided with the distribution.
//     * Neither the name of the AntsAdventureGameCreator nor the names of its contributors 
//         may be used to endorse or promote products derived from this software without 
//         specific prior written permission.
// 
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
// SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
// THE POSSIBILITY OF SUCH DAMAGE.
#pragma once
#include "ClientTypedefs.h"
#include "AntsApi_NoDependencies.h"
class CommandLine;
class Room;
class Verbs;
class Inventory;
class RoomRegistry;
class SavedStateManager;
class KeywordRegistry;

/*!
@namespace AntsApi
These methods can all be used in the IEventHandlers. 

Four of these methods return objects representing the
four areas of the main screen (eg Room, CommandLine, Verbs, Inventory) 
whilst others return objects that representing other user interface elements: 
(eg SavedStateManager ) and the rest of the methods are utility methods
that are useful in IEventHandler methods.
*/
namespace AntsApi
{
    CommandLine& GetCommandLine();
    Room& GetRoom();
    Verbs& GetVerbs();
    Inventory& GetInventory();
    RoomRegistry& GetRoomRegistry();
    SavedStateManager& GetSavedStateManager();
    KeywordRegistry& GetKeywordRegistry();

    /*! This exits the current room, and enters the specified room, triggering
    an ExitRoom() event, and an EnterRoom event respectively. */
    void MakeRoomActive(QString);

    void SetIsInChoicesMode(bool isChoicesMode);
    bool IsInChoicesMode();

    int GetValue(QString name);
    void SetValue(QString name, int i);
}

using namespace AntsApi;
